You are here: Vocalocity Voice Browser: VoiceXML Implementation Reference > VoiceXML Element Summary > VoiceXML Summary
The following table is a summary of the current VoiceXML elements supported in this release of the Vocalocity Voice Browser.
Element |
Purpose |
Implementation Notes |
---|---|---|
Assign a variable a value |
Implemented as defined in VoiceXML 2.0. |
|
Play an audio clip within a prompt |
The VoiceXML interpreter processes audio content so that only text is sent to the TTS engine; pre-recorded audio is played by the telephony hardware. For more information, see <audio> Element. |
|
A container of (non-interactive) executable code |
Implemented as defined in VoiceXML 2.0. |
|
Control the pausing or other prosodic boundaries between words |
Implemented as defined in VoiceXML 2.0. |
|
Catch an event |
Implemented as defined in VoiceXML 2.0. |
|
Define a menu item or specify a speech or DTMF grammar, |
Up to 100 <choice> tags are supported for each menu. Exactly one of "next", "expr", "event" or "eventexpr" must be specified; otherwise, an error.badfetch event is thrown. Exactly one of "message" or "messageexpr" may be specified; otherwise, an error.badfetch event is thrown. |
|
Clear one or more form item variables |
Implemented as defined in VoiceXML 2.0 |
|
Allows a VoiceXML application to fetch XML data from a document server without transitioning to a new VoiceXML document |
New in VoiceXML 2.1 A Java system property – vocalos.vxml.data.access_control.allow – can be set to configure the default behavior if the returned XML content does not contain the access-control XML processing instruction. See <data> Element. |
|
Disconnect a session |
The namelist values are passed to the TEP implementation for further processing. Upon processing of <disconnect/> the prompt queue will be flushed before sending the hangup command to the TEP. |
|
Used in <if> elements |
Implemented as defined in VoiceXML 2.0. |
|
Used in <if> elements |
Implemented as defined in VoiceXML 2.0. |
|
Shorthand for enumerating the choices in a menu. An automatically generated description of the choices available to the user. |
Implemented as defined in VoiceXML 2.0. <enumerate> specifies a template that is applied to each choice in the order they appear in the menu. If it is used with no content, the VoiceXML interpreter uses the following template:
|
|
Catch an error event |
Implemented as defined in VoiceXML 2.0. An abbreviation for <catch event="error"> element |
|
Exit a session and returns control to the interpreter context which determines what to do next |
The namelist values are passed to the TEP implementation for further processing. Upon processing the </exit> the prompt queue will be flushed before sending the hangup command to the TEP. |
|
Declares an input field in a form – an input to be gathered from the user |
Implemented as defined in VoiceXML 2.0 |
|
An action executed when fields are filled |
Implemented as defined in VoiceXML 2.0 |
|
Allows a VoiceXML application to iterate through an ECMAScript array and to execute the content contained within the <foreach> element for each item in the array |
New in VoiceXML 2.1 Implemented as defined in VoiceXML 2.1 |
|
A dialog for presenting information and collecting data |
Implemented as defined in VoiceXML 2.0 |
|
Go to another dialog in the same or different document |
Implemented as defined in VoiceXML 2.0 |
|
Specify a speech recognition or DTMF grammar |
Implemented as defined in VoiceXML 2.0 |
|
Catch a help event |
Implemented as defined in VoiceXML 2.0. An abbreviation for <catch event="help"> element Grammars generated for all system level prompts such as "help" and "exit" are generated in US English only. |
|
Simple conditional logic |
Implemented as defined in VoiceXML 2.0 |
|
Declares initial logic upon entry into a (mixed initiative) form |
Implemented as defined in VoiceXML 2.0 |
|
Specify a transition common to all dialogs in the link's scope |
Implemented as defined in VoiceXML 2.0 |
|
Generate a debug message |
Implemented as defined in VoiceXML 2.0 An application can log the content of the log tag to a Log4J category. For more information, see <log> Element. For SpeechWorks OSR, any log tag starting with SWI will be logged to the SPWK log. |
|
A dialog for choosing amongst alternative destinations |
Implemented as defined in VoiceXML 2.0 |
|
Define a metadata item as a name/value pair |
The following meta properties are supported: n Expires (http-equiv) n Pragma (http-equiv) n Cache-Control (http-equiv) For more information, see <meta> Element. |
|
Define metadata information using a metadata schema |
This element is supported, but not used by the Vocalocity Voice Browser. |
|
Catch a noinput event |
Implemented as defined in VoiceXML 2.0 An abbreviation for <catch event="noinput"> element |
|
Catch a nomatch event |
Implemented as defined in VoiceXML 2.0 An abbreviation for <catch event="nomatch"> element |
|
Interact with a custom extension |
Use the Vocalocity Object API to register a custom object implementation. If you use this tag without registering the object, an error.object.notsupported event will be thrown. |
|
Specify an option in a <field> |
Implemented as defined in VoiceXML 2.0 |
|
Parameter in <object> or <subdialog> |
Implemented as defined in VoiceXML 2.0 |
|
Queue speech synthesis and audio output to the user |
The attribute bargeintype is not supported. Recognition-based bargein is not currently supported. Regardless of the value of the bargeintype attribute, the browser will always use energy. For information about bargein support, see Bargein . |
|
Control implementation platform settings (such as recognition process, timeouts, caching policy, etc.) |
The Vocalocity Voice Browser sets default properties, if not specified by <property>. For more information, see Vocalocity Property Defaults. |
|
Record an audio sample |
The timeout attribute is ignored (the VoiceXML interpreter will not throw a <noinput> event if timeout is exceeded before recording begins). Use finalsilence attribute to set interval that indicates end of speech to record. |
|
Play a field prompt when a field is re-visited after an event |
Implemented as defined in VoiceXML 2.0 |
|
End execution of a subdialog and return control and data to the calling dialog |
Implemented as defined in VoiceXML 2.0 |
|
Specify a block of ECMAScript client-side scripting logic |
Implemented as defined in VoiceXML 2.0 If not specified, the default encoding is UTF-8. For additional information about ECMAScript usage, see ECMAScript. |
|
Invoke another dialog as a subdialog of the current one |
Implemented as defined in VoiceXML 2.0 |
|
Submit values to a document server |
When submitting a variable that contains recorded content, the browser will use the value of "multipart/form-data" for the enctype attribute, regardless of what is supplied by the application. |
|
Throw an event |
Implemented as defined in VoiceXML 2.0 |
|
Transfer the caller to another destination |
The Vocalocity Voice Browser supports: n Bridge transfer (bridge="true") n Blind transfer (bridge="false") The default is blind. Hot word transfer cancellation is not supported. The transferaudio attribute is not supported. |
|
Insert the value of an expression in a prompt |
Implemented as defined in VoiceXML 2.0 |
|
Declare a variable |
Implemented as defined in VoiceXML 2.0 |
|
Top-level element in each VoiceXML document |
Implemented as defined in VoiceXML 2.0 Required attributes: n version="2.0" (for VoiceXML 2.0) n xmlns=http://www.w3.org/2001/vxml |